GUI: Displaying Jetfire Workflows

Modified on 2011/04/22 21:24 by Charles — Categorized as: GUI, Website Design

Table of Contents [Hide/Show]

   Displaying Jetfire Workflows in the GUI
      Jetfire Find Workflow Criteria
      Find Workflow Criteria Enumeration
      Workflow Collections
      Finding Workflows
      Sorting Workflows
      Filtering Workflows
      Show All Versions

Find Workflows

Displaying Jetfire Workflows in the GUI¶

Workflows come in all 'shapes and sizes'. Jetfire Administrators need to easily identify what workflows should be displayed to Jetfire Users for different applications. This page describes how to configure Web Parts to display workflows.

The figure to the right shows the properties that are used to Find Workflows used in a Web Part. This is used as standard input.

Jetfire Find Workflow Criteria¶

Find Workflow Criteria is used in Web Part Editors to select Workflows to be displayed. Find Workflow Criteria uses attributes of the workflow to find workflows.

Workflow Attributes include:

Root - workflows may be saved at the Root of the Workspace or referenced by another workflow.
Visibility - workflows my be visible or hidden.
Workflow Class - the name of one or more workflow classes.
Workspace - the name of the workspace that workflows belong to.
Workflow State - the state that a workflow may be in.
Guid - each workflow has a unique identifier called a Guid.
Collection - workflows in a collection.

Find Workflow Criteria Enumeration¶

Select the way that Workflows are found:

WhereAllVisible - Workflows that are Visible.
AsRoot - Workflows added as Root Workflows to the workspace.
AsRootAndVisible - Workflows add as Root Workflows and are visible.
ByWorkflowClass - Workflows belonging to a specific Workflow Class(es).
ByWorkflowClassHidden - Workflows belonging to a specific Workflow Class(es) that are hidden.
ByWorkflowClassAll - Workflows belonging to a specific Workflow Class(es) that are visible and hidden.
ByWorkspace - Workflows belonging to a specific Workspace(s).
ByWorkspaceAndVisible - Workflows belonging to a specific Workspace(s) and are visible.
ByGuid - Workflows with a specific Guid(s).
ByState - Workflows belonging to a specific Workflow Class(es) with a specific state.
ByWorkspaceAndState - Workflows belonging to a specific Workflow Class(es) and Workspace with a specific state.
InCollection - Workflows in a predefined collection.

Workflow Collections¶

The Find Workflow Criteria produces collections that are ready-to-use in Jetfire Web Parts.

Some of the common Workflow properties that are used to create collections include:

Hidden - a flag (true/false) that identifies whether the workflow is normal visible is hidden.
Root - identifies if the workflow reference is tied to the workspace. If the workflow is not a root workflow, then it has a 'weak' reference, which means that the workflow may be easily deleted if the workflow that it belongs to is deleted.
- Non-root workflows are typically used for notes that belong to a parent workflow, such as a contact.
Workflow Class - one or more workflow class names that identify a set of workflows.
- e.g. show the list of 'OawaContact' workflows will display the visible workflow of class 'OawaContact'.
Workspace - all workflows in a workspace
State - all workflows with a specific state.
- The State qualification is typically used in conjunction with either workspace or workflow class. Most Workflow Classes have a different set of states. However, if the Workflow Designer designed workflows using an interface that defines a common set of states, then retrieving workflows by state can be quite useful. e.g. get all 'Contact's that are in the 'Vacation' state will show all types of contacts that are on vacation.

Finding Workflows¶

The Find Workflow Criteria enumeration is used in conjunction with other parameters to find workflows. These vary by enumerated value, but include:

one or more workflow classes
workspace
workflow state
the version of workflow classes to display

Sorting Workflows¶

Workflows may be sorted before being displayed to the user. Sort options include:

Ascending alphabetical order of the Subject
Descending alphabetical order of the Subject
ClassName: Sort workflow Class Name in Ascending order.
Chronological: Sort by workflow Timestamps (lowest first).
ReverseChronological: Sort by workflow Timestamps (highest first).
None: No sorting is done.

Filtering Workflows¶

Filtering Workflows is used to reduce the number of workflows in a collection. The Jetfire Administrator may identify property names with specific values to display.

Some of the Web Parts display workflows for a specific month. A filter is used to look for workflows where the Date property has a specific Month and Year.

Show All Versions¶

Jetfire Workflows support versioning. This allows the Workflow Designer to update Jetfire code to update new functionality on-the-fly. When searching for workflows, the Jetfire Administrator can identify whether the collection includes all versions for the workflow class or just the current version.

If true, then all versions of a Code Class are used. If false, then the newest version of the Code Class is used.